/**
 *    Copyright 2009-2015 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.apache.ibatis.mapping.ResultSetType;
import org.apache.ibatis.mapping.StatementType;

/**
 * 提供访问交换和配置选项的宽广范围
 * 
 * @author Clinton Begin
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Options {
	/**
	 * 是否使用缓存
	 * 
	 * @return
	 */
	boolean useCache() default true;

	/**
	 * 是否刷新缓存
	 * 
	 * @return
	 */
	boolean flushCache() default false;

	/**
	 * 结果集类型
	 * 
	 * @return
	 */
	ResultSetType resultSetType() default ResultSetType.FORWARD_ONLY;

	/**
	 * 语句类型
	 * 
	 * @return
	 */
	StatementType statementType() default StatementType.PREPARED;

	/**
	 * 每次查询的数量
	 * 
	 * @return
	 */
	int fetchSize() default -1;

	/**
	 * 超时的时间
	 * 
	 * @return
	 */
	int timeout() default -1;

	/**
	 * 是否使用主键生成
	 * 
	 * @return
	 */
	boolean useGeneratedKeys() default false;

	/**
	 * key的属性
	 * 
	 * @return
	 */
	String keyProperty() default "id";

	/**
	 * key的列
	 * 
	 * @return
	 */
	String keyColumn() default "";
}
